'\" t
.\"     Title: pacemaker-fenced
.\"    Author: Andrew Beekhof <andrew@beekhof.net>
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 03/27/2020
.\"    Manual: Pacemaker Configuration
.\"    Source: Pacemaker Configuration
.\"  Language: English
.\"
.TH "PACEMAKER\-FENCED" "7" "03/27/2020" "Pacemaker Configuration" "Pacemaker Configuration"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
pacemaker-fenced \- Instance attributes available for all "stonith"\-class resources
.SH "SYNOPSIS"
.PP
[\fBpcmk_host_argument\fR=string] [\fBpcmk_host_map\fR=string] [\fBpcmk_host_list\fR=string] [\fBpcmk_host_check\fR=string] [\fBpcmk_delay_max\fR=time] [\fBpcmk_delay_base\fR=time] [\fBpcmk_action_limit\fR=integer] [\fBpcmk_reboot_action\fR=string] [\fBpcmk_reboot_timeout\fR=time] [\fBpcmk_reboot_retries\fR=integer] [\fBpcmk_off_action\fR=string] [\fBpcmk_off_timeout\fR=time] [\fBpcmk_off_retries\fR=integer] [\fBpcmk_on_action\fR=string] [\fBpcmk_on_timeout\fR=time] [\fBpcmk_on_retries\fR=integer] [\fBpcmk_list_action\fR=string] [\fBpcmk_list_timeout\fR=time] [\fBpcmk_list_retries\fR=integer] [\fBpcmk_monitor_action\fR=string] [\fBpcmk_monitor_timeout\fR=time] [\fBpcmk_monitor_retries\fR=integer] [\fBpcmk_status_action\fR=string] [\fBpcmk_status_timeout\fR=time] [\fBpcmk_status_retries\fR=integer]
.SH "DESCRIPTION"
.PP
Instance attributes available for all "stonith"\-class resources and used by Pacemaker\*(Aqs fence daemon, formerly known as stonithd
.SH "SUPPORTED PARAMETERS"
.PP
\fBpcmk_host_argument\fR = string [port]
.RS 4
Advanced use only: An alternate parameter to supply instead of \*(Aqport\*(Aq
.sp
Some devices do not support the standard \*(Aqport\*(Aq parameter or may provide additional ones\&. Use this to specify an alternate, device\-specific, parameter that should indicate the machine to be fenced\&. A value of \*(Aqnone\*(Aq can be used to tell the cluster not to supply any additional parameters\&.
.RE
.PP
\fBpcmk_host_map\fR = string []
.RS 4
A mapping of host names to ports numbers for devices that do not support host names\&.
.sp
Eg\&. node1:1;node2:2,3 would tell the cluster to use port 1 for node1 and ports 2 and 3 for node2
.RE
.PP
\fBpcmk_host_list\fR = string []
.RS 4
A list of machines controlled by this device (Optional unless pcmk_host_check=static\-list)\&.
.sp
.RE
.PP
\fBpcmk_host_check\fR = string [dynamic\-list]
.RS 4
How to determine which machines are controlled by the device\&.
.sp
Allowed values: dynamic\-list (query the device via the \*(Aqlist\*(Aq command), static\-list (check the pcmk_host_list attribute), status (query the device via the \*(Aqstatus\*(Aq command), none (assume every device can fence every machine)
.RE
.PP
\fBpcmk_delay_max\fR = time [0s]
.RS 4
Enable a random delay for stonith actions and specify the maximum of random delay\&.
.sp
This prevents double fencing when using slow devices such as sbd\&. Use this to enable a random delay for stonith actions\&. The overall delay is derived from this random delay value adding a static delay so that the sum is kept below the maximum delay\&.
.RE
.PP
\fBpcmk_delay_base\fR = time [0s]
.RS 4
Enable a base delay for stonith actions and specify base delay value\&.
.sp
This prevents double fencing when different delays are configured on the nodes\&. Use this to enable a static delay for stonith actions\&. The overall delay is derived from a random delay value adding this static delay so that the sum is kept below the maximum delay\&.
.RE
.PP
\fBpcmk_action_limit\fR = integer [1]
.RS 4
The maximum number of actions can be performed in parallel on this device
.sp
Cluster property concurrent\-fencing=true needs to be configured first\&. Then use this to specify the maximum number of actions can be performed in parallel on this device\&. \-1 is unlimited\&.
.RE
.PP
\fBpcmk_reboot_action\fR = string [reboot]
.RS 4
Advanced use only: An alternate command to run instead of \*(Aqreboot\*(Aq
.sp
Some devices do not support the standard commands or may provide additional ones\&. Use this to specify an alternate, device\-specific, command that implements the \*(Aqreboot\*(Aq action\&.
.RE
.PP
\fBpcmk_reboot_timeout\fR = time [60s]
.RS 4
Advanced use only: Specify an alternate timeout to use for reboot actions instead of stonith\-timeout
.sp
Some devices need much more/less time to complete than normal\&. Use this to specify an alternate, device\-specific, timeout for \*(Aqreboot\*(Aq actions\&.
.RE
.PP
\fBpcmk_reboot_retries\fR = integer [2]
.RS 4
Advanced use only: The maximum number of times to retry the \*(Aqreboot\*(Aq command within the timeout period
.sp
Some devices do not support multiple connections\&. Operations may \*(Aqfail\*(Aq if the device is busy with another task so Pacemaker will automatically retry the operation, if there is time remaining\&. Use this option to alter the number of times Pacemaker retries \*(Aqreboot\*(Aq actions before giving up\&.
.RE
.PP
\fBpcmk_off_action\fR = string [off]
.RS 4
Advanced use only: An alternate command to run instead of \*(Aqoff\*(Aq
.sp
Some devices do not support the standard commands or may provide additional ones\&. Use this to specify an alternate, device\-specific, command that implements the \*(Aqoff\*(Aq action\&.
.RE
.PP
\fBpcmk_off_timeout\fR = time [60s]
.RS 4
Advanced use only: Specify an alternate timeout to use for off actions instead of stonith\-timeout
.sp
Some devices need much more/less time to complete than normal\&. Use this to specify an alternate, device\-specific, timeout for \*(Aqoff\*(Aq actions\&.
.RE
.PP
\fBpcmk_off_retries\fR = integer [2]
.RS 4
Advanced use only: The maximum number of times to retry the \*(Aqoff\*(Aq command within the timeout period
.sp
Some devices do not support multiple connections\&. Operations may \*(Aqfail\*(Aq if the device is busy with another task so Pacemaker will automatically retry the operation, if there is time remaining\&. Use this option to alter the number of times Pacemaker retries \*(Aqoff\*(Aq actions before giving up\&.
.RE
.PP
\fBpcmk_on_action\fR = string [on]
.RS 4
Advanced use only: An alternate command to run instead of \*(Aqon\*(Aq
.sp
Some devices do not support the standard commands or may provide additional ones\&. Use this to specify an alternate, device\-specific, command that implements the \*(Aqon\*(Aq action\&.
.RE
.PP
\fBpcmk_on_timeout\fR = time [60s]
.RS 4
Advanced use only: Specify an alternate timeout to use for on actions instead of stonith\-timeout
.sp
Some devices need much more/less time to complete than normal\&. Use this to specify an alternate, device\-specific, timeout for \*(Aqon\*(Aq actions\&.
.RE
.PP
\fBpcmk_on_retries\fR = integer [2]
.RS 4
Advanced use only: The maximum number of times to retry the \*(Aqon\*(Aq command within the timeout period
.sp
Some devices do not support multiple connections\&. Operations may \*(Aqfail\*(Aq if the device is busy with another task so Pacemaker will automatically retry the operation, if there is time remaining\&. Use this option to alter the number of times Pacemaker retries \*(Aqon\*(Aq actions before giving up\&.
.RE
.PP
\fBpcmk_list_action\fR = string [list]
.RS 4
Advanced use only: An alternate command to run instead of \*(Aqlist\*(Aq
.sp
Some devices do not support the standard commands or may provide additional ones\&. Use this to specify an alternate, device\-specific, command that implements the \*(Aqlist\*(Aq action\&.
.RE
.PP
\fBpcmk_list_timeout\fR = time [60s]
.RS 4
Advanced use only: Specify an alternate timeout to use for list actions instead of stonith\-timeout
.sp
Some devices need much more/less time to complete than normal\&. Use this to specify an alternate, device\-specific, timeout for \*(Aqlist\*(Aq actions\&.
.RE
.PP
\fBpcmk_list_retries\fR = integer [2]
.RS 4
Advanced use only: The maximum number of times to retry the \*(Aqlist\*(Aq command within the timeout period
.sp
Some devices do not support multiple connections\&. Operations may \*(Aqfail\*(Aq if the device is busy with another task so Pacemaker will automatically retry the operation, if there is time remaining\&. Use this option to alter the number of times Pacemaker retries \*(Aqlist\*(Aq actions before giving up\&.
.RE
.PP
\fBpcmk_monitor_action\fR = string [monitor]
.RS 4
Advanced use only: An alternate command to run instead of \*(Aqmonitor\*(Aq
.sp
Some devices do not support the standard commands or may provide additional ones\&. Use this to specify an alternate, device\-specific, command that implements the \*(Aqmonitor\*(Aq action\&.
.RE
.PP
\fBpcmk_monitor_timeout\fR = time [60s]
.RS 4
Advanced use only: Specify an alternate timeout to use for monitor actions instead of stonith\-timeout
.sp
Some devices need much more/less time to complete than normal\&. Use this to specify an alternate, device\-specific, timeout for \*(Aqmonitor\*(Aq actions\&.
.RE
.PP
\fBpcmk_monitor_retries\fR = integer [2]
.RS 4
Advanced use only: The maximum number of times to retry the \*(Aqmonitor\*(Aq command within the timeout period
.sp
Some devices do not support multiple connections\&. Operations may \*(Aqfail\*(Aq if the device is busy with another task so Pacemaker will automatically retry the operation, if there is time remaining\&. Use this option to alter the number of times Pacemaker retries \*(Aqmonitor\*(Aq actions before giving up\&.
.RE
.PP
\fBpcmk_status_action\fR = string [status]
.RS 4
Advanced use only: An alternate command to run instead of \*(Aqstatus\*(Aq
.sp
Some devices do not support the standard commands or may provide additional ones\&. Use this to specify an alternate, device\-specific, command that implements the \*(Aqstatus\*(Aq action\&.
.RE
.PP
\fBpcmk_status_timeout\fR = time [60s]
.RS 4
Advanced use only: Specify an alternate timeout to use for status actions instead of stonith\-timeout
.sp
Some devices need much more/less time to complete than normal\&. Use this to specify an alternate, device\-specific, timeout for \*(Aqstatus\*(Aq actions\&.
.RE
.PP
\fBpcmk_status_retries\fR = integer [2]
.RS 4
Advanced use only: The maximum number of times to retry the \*(Aqstatus\*(Aq command within the timeout period
.sp
Some devices do not support multiple connections\&. Operations may \*(Aqfail\*(Aq if the device is busy with another task so Pacemaker will automatically retry the operation, if there is time remaining\&. Use this option to alter the number of times Pacemaker retries \*(Aqstatus\*(Aq actions before giving up\&.
.RE
.SH "AUTHOR"
.PP
\fBAndrew Beekhof\fR <\&andrew@beekhof\&.net\&>
.RS 4
Author.
.RE
